GET api/documents/{authenticationToken}/{id}
This methods the document information for a specific document (task).
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authenticationToken |
Current authentication token |
string |
Required |
id |
This is the document (task) id for the desired document. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
This returns the document information for the requested document.
DocumentModelName | Description | Type | Additional information |
---|---|---|---|
TaskId |
This is the identifier for the document (task). |
integer |
None. |
Name |
This is the name of the document |
string |
None. |
Description |
This is the description of the document |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "TaskId": 1, "Name": "sample string 2", "Description": "sample string 3" }
application/xml, text/xml
Sample:
<DocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models"> <Description>sample string 3</Description> <Name>sample string 2</Name> <TaskId>1</TaskId> </DocumentModel>